Import Content from a PIE file

{ importContent }

Import content items stored in a Pyramid PIE archive file.

Method

/API3/content/importContent

  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by admin users only
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    pieApiObject

    Object Type

    Description

    The object representing the details for where to import a PIE file of content.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    The import content items result object from importing content into the system.

    Notes

    PIE files can contain any content items previously exported - including folders. Certain content items will include constituent (child) items as well. The response from the method - ImportApiResultObject - a map of the item id that was exported associated to a list of ConnStringDscApiObject, where each object holds a connection string property and a flag that indicated whether a data source change is required for the item.It is recommended that this API would not get executed in parallel.

    Examples

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/content/importContent" \
     -d '{
      "fileZippedData" : "fileZippedData",
      "rolesAssignmentType" : "UseDefaultBehavior",
      "roleIds" : [ "roleIds", "roleIds" ],
      "rootFolderId" : "rootFolderId",
      "clashDefaultOption" : "REGULAR_PIE_IMPORT"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.ContentServiceApi;
    
    import java.util.*;
    
    public class ContentServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            ContentServiceApi apiInstance = new ContentServiceApi();
            // Initialize the pieApiObject parameter object for the call
            PieApiObject pieApiObject = ; // PieApiObject | 
    
            try {
                ImportApiResultObject result = apiInstance.importContent(pieApiObject);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling ContentServiceApi#importContent");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
    const pieApiObject = ; // {PieApiObject} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.importContent(pieApiObject, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class importContentExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new ContentServiceApi();
            // Initialize the pieApiObject parameter object for the call
            var pieApiObject = new PieApiObject(); // PieApiObject | 
    
            try {
                // Import content items stored in a Pyramid PIE archive file.
                ImportApiResultObject result = apiInstance.importContent(pieApiObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentServiceApi.importContent: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.ContentServiceApi(api_client)
        # Initialize the pieApiObject parameter object for the call
        pieApiObject =  # PieApiObject | 
    
        try:
            # Import content items stored in a Pyramid PIE archive file.
            api_response = api_instance.import_content(pieApiObject)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling ContentServiceApi->importContent: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
    $pieApiObject = ; // PieApiObject | 
    
    try {
        $result = $api_instance->importContent($pieApiObject);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ContentServiceApi->importContent: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.